task: Drop the join waker of a task eagerly when the JoinHandle gets dropped or the task completes #6986
+197
−20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
R-loom-current-thread
tglane
force-pushed
the
release-waker-on-completion
branch
from
f80d191 to
217b26d
Compare
dropped or the task completes Currently, the waker registered with a JoinHandle is not dropped until the task allocation is dropped. This behaviour may cause the memory allocated by a task to not be freed when in the case of two tasks awaiting each others JoinHandle. This commit changes the behaviour by actively dropping the waker when the JoinHandle gets dropped (or the task completes in some cases).
tglane
force-pushed
the
release-waker-on-completion
branch
from
217b26d to
163d841
Compare
Darksonn
added
A-tokio
Darksonn
reviewed
Nov 25, 2024
tglane
force-pushed
the
release-waker-on-completion
branch
from
eca9c26 to
c96a70d
Compare
tglane
force-pushed
the
release-waker-on-completion
branch
from
c96a70d to
d457bbb
Compare
Darksonn
reviewed
Dec 4, 2024
* `State::transition_do_join_handle_drop` now returns a struct with to booleans to indicate what the JoinHandle should drop * Use `fetch_and` when unsetting JOIN_WAKER after COMPLETE
Darksonn
reviewed
Dec 5, 2024
* Added missing ';' after unsafe blocks * Improved documentation in `State::transition_to_join_handle_dropped` on the scenarios in which `JOIN_WAKER` gets unset
Darksonn
reviewed
Dec 9, 2024
tglane
force-pushed
the
release-waker-on-completion
branch
from
46f40da to
9f840cf
Compare
ref cycle test into a non-loom test (leaks will be detected by miri)
tglane
force-pushed
the
release-waker-on-completion
branch
from
9f840cf to
4733c9f
Compare
Darksonn
approved these changes
Dec 29, 2024
tokio/src/runtime/tests/task.rs
Outdated
Comment on lines
50
to
51
| #[test] | ||
| fn drop_tasks_with_reference_cycle() { |
There was a problem hiding this comment.
This does not use any Tokio internals, so it does not need to be inside src/. It should be in tokio/tests/ instead.
There was a problem hiding this comment.
Oh thanks I wasnt aware of this but will keep it in mind for the future.
There was a problem hiding this comment.
No worries. Thanks a lot for the PR!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Currently, the waker registered with a JoinHandle is not dropped until the task allocation is dropped. This behaviour may cause the memory allocated by a task to not be freed when in the case of two tasks awaiting each others JoinHandle.
See #6505 for more details.
Solution
To prevent this we need to actively drop the waker when the
JoinHandlegets dropped (or the task completes in some cases).Closes #6505.